/*
 *      ISymEntry.java
 *
 *      Copyright 2008 Pablo Nicolas Diaz Bilotto <pablonicolas.diaz@gmail.com>
 *
 *      This program is free software; you can redistribute it and/or modify
 *      it under the terms of the GNU General Public License as published by
 *      the Free Software Foundation; either version 2 of the License, or
 *      (at your option) any later version.
 *
 *      This program is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *      GNU General Public License for more details.
 *
 *      You should have received a copy of the GNU General Public License
 *      along with this program; if not, write to the Free Software
 *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *      MA 02110-1301, USA.
 */
package symbolStorageService;

import lexer.EntryType;
import lexer.token.TokenEnum;


/**
 * The Interface ISymEntry.
 */
public interface ISymEntry {

	/**
	 * Gets the kind.
	 *
	 * @return the kind
	 */
	TokenEnum getKind();

	/**
	 * Gets the line number.
	 *
	 * @return the line number
	 */
	int getLineNumber();

	/**
	 * Gets the type.
	 *
	 * @return the type
	 */
	EntryType getType();

	/**
	 * Checks if is keyword.
	 *
	 * @return true, if is keyword
	 */

	boolean isKeyword();

	/**
	 * Checks if is typed.
	 *
	 * @return true, if is typed
	 */
	boolean isTyped();

	/**
	 * Checks if is used.
	 *
	 * @return true, if is used
	 */
	boolean isUsed();

	/**
	 * Sets the type.
	 *
	 * @param type
	 *            the new type
	 */
	void setType(final EntryType type);

	/**
	 * Sets the used.
	 *
	 * @param used
	 *            the new used
	 */
	void setUsed(final boolean used);
	String  toGui();
}